Spread WPF 17
GrapeCity.CalcEngine.Functions Namespace / CalcYieldFunction Class / Evaluate Method / Evaluate(Object[]) Method

The args contains 6 - 7 items: settlement, maturity, rate, pr, redemption, frequency, [basis].

Settlement is the security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

Maturity is the security's maturity date. The maturity date is the date when the security expires.

Rate is the security's annual coupon rate.

Pr is the security's price per $100 face value.

Redemption is the security's redemption value per $100 face value.

Frequency is the number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.

Basis is the type of day count basis to use.



In This Topic
    Evaluate(Object[]) Method
    In This Topic
    Returns the System.Double yield on a security that pays periodic interest. Use YIELD to calculate bond yield.
    Syntax
    'Declaration
     
    Public Overloads Overrides Function Evaluate( _
       ByVal args() As Object _
    ) As Object
    'Usage
     
    Dim instance As CalcYieldFunction
    Dim args() As Object
    Dim value As Object
     
    value = instance.Evaluate(args)
    public override object Evaluate( 
       object[] args
    )

    Parameters

    args

    The args contains 6 - 7 items: settlement, maturity, rate, pr, redemption, frequency, [basis].

    Settlement is the security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

    Maturity is the security's maturity date. The maturity date is the date when the security expires.

    Rate is the security's annual coupon rate.

    Pr is the security's price per $100 face value.

    Redemption is the security's redemption value per $100 face value.

    Frequency is the number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.

    Basis is the type of day count basis to use.

    Return Value

    A System.Double value that indicates the evaluate result.
    See Also